Update docstrings for clarity #273
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #273 +/- ##
=======================================
Coverage 99.92% 99.93%
=======================================
Files 24 24
Lines 1398 1446 +48
=======================================
+ Hits 1397 1445 +48
Misses 1 1
🚀 New features to boost your workflow:
|
sbillinge
reviewed
Dec 18, 2025
Contributor
sbillinge
left a comment
sbillinge
left a comment
There was a problem hiding this comment.
this is getting much better. Still a few things to look at.
news/docstring.rst
Outdated
|
|
||
| **Changed:** | ||
|
|
||
| * Docstrings updated for better clarity |
Contributor
There was a problem hiding this comment.
this is a fix not a change. Changes refer to changes in user-functionality
src/diffpy/morph/morphapp.py
Outdated
| help="""Look for FIELD in a serial file instead. | ||
| Must specify name of serial file SERIALFILE.""", | ||
| help=( | ||
| "Look for FIELD in a serial file instead. " |
Contributor
There was a problem hiding this comment.
What is a "serial file"? I think we need some more user-friendly text to help with understanding here.
src/diffpy/morph/morphapp.py
Outdated
| "entry, there should be a key {__save_morph_as__} whose value " | ||
| "specifies the name to save the manipulated function as." | ||
| "using a serial file NAMESFILE. The format of NAMESFILE should " | ||
| "be as follows: each target PDF is an entry in NAMESFILE. " |
Contributor
There was a problem hiding this comment.
I think we want PDF out here? function instead?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update our docstrings for clarity. Also remove vestigial references to PDFs.
Closes #268.
Closes #269.